docs: Document Flash endpoint/app lifecycle operations are now CLI-only#681
Conversation
Flash SDK v1.18.0 (runpod/flash#346) restricts lifecycle operations (deploy, undeploy, update, app/env create/delete) to the CLI; direct SDK calls now raise FlashUsageError. Add a Note on the deploy page and a Breaking entry to the product updates page.
![promptless[bot]](https://avatars.githubusercontent.com/in/979718?s=60&v=4){kind=small}
| ``` | ||
|
|
||
| <Note> | ||
| The Flash CLI manages endpoint and app lifecycle operations: `deploy`, `undeploy`, `update`, and creating or deleting apps and environments. If you call these methods directly from the SDK, Flash raises a `FlashUsageError` that names the equivalent `flash` command. Routing lifecycle changes through the CLI keeps the build and manifest pipeline aligned with Flash's local state tracking. Direct SDK calls bypass that orchestration and can leave deployments in an inconsistent state. |
There was a problem hiding this comment.
PR #346 (feat(sdk): make endpoint/app lifecycle operations CLI-only) adds a cli_only() decorator in core/cli_context.py and applies it to ServerlessResource.{deploy,undeploy,update}, NetworkVolume.deploy, and FlashApp create/delete/environment methods. The decorator raises FlashUsageError naming the equivalent flash command when called outside the CLI, because direct SDK calls bypass the build/manifest pipeline and local state tracking. This Note documents that behavior.
Source: runpod/flash#346
| <Update label="June 2026"> | ||
| ### Jun.30 Breaking — Lifecycle operations are now CLI-only | ||
|
|
||
| :warning: Flash SDK methods for endpoint and app lifecycle operations—deploy, undeploy, update, and creating or deleting apps and environments—now raise a `FlashUsageError` that points to the equivalent `flash` command. Run these operations through the [Flash CLI](/flash/cli/overview) instead, which keeps the build and manifest pipeline and local state tracking consistent. |
There was a problem hiding this comment.
PR #346 shipped in Flash v1.18.0 (release PR runpod/flash#349, merged 2026-06-30). The cli_only decorator's error message in core/cli_context.py states the method "is a CLI-managed operation and cannot be called directly from the SDK" and names the equivalent flash command, which this Breaking changelog entry summarizes.
Source: runpod/flash#346
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
|
Just a reminder: If you'd like me to act on any feedback you have via Github comments, just type @Promptless in your suggestion and I'll get right on it! (I won't show up in the user dropdown, but I'll process any request that has @Promptless in the comment body.) |
1 participant
Open this suggestion in Promptless to view citations and reasoning process
Documents that Flash SDK v1.18.0 restricts endpoint and app lifecycle operations (deploy, undeploy, update, app/environment create/delete) to the Flash CLI; direct SDK calls now raise FlashUsageError naming the equivalent flash command. Adds a Note to the deploy page and a Breaking entry to the product updates page. Reflects runpod/flash PR #346 (SLS-335).
Trigger Events
Tip: Tag @Promptless in a GitHub issue to turn it into a documentation update 🐙